Get an Item's Data Source Details

Retrieves the connection details of the content item.

Method

/API3/dataSources/getItemConnectionString

  • API Section: /API3/dataSources
  • API Version: 3.0
  • From Release: 2023.10
  • Usage: REST API and Client SDK libraries. REST APIs via POST actions only.
  • Usage by:
    • Enterprise Admin

Method Signature

Input Parameters

Name

pyramidItemIdentifier

Object Type

PyramidItemIdentifier

Description

The item idenifier object.

Output Response

Successful Result Code

200

Response List Type

ConnectionStringProperties[]

Description of Response Type

The connection object representing the details of the data sources.. Note that the response is returned as a list of items of this object type.

Code Snippets

Use the Authentication API methods to generate an access 'key' or 'token' for use in code as shown below.

TypeScript
Curl
Java
C#
Python
PHP
curl -X POST \
-H "paToken: [[apiKey]]" \
 -H "Accept: application/json,application/json;charset=utf-8,text/plain,text/plain;charset=utf-8" \
 -H "Content-Type: application/json" \
 "http://Your.Server.URL/API3/dataSources/getItemConnectionString" \
 -d '{
  "itemId" : "itemId"
}'

import com.pyramidanalytics.*;
import com.pyramidanalytics.auth.*;
import com.pyramidanalytics.model.*;
import com.pyramidanalytics.api.DataSourcesServiceApi;

import java.util.*;
import java.time.*;

public class DataSourcesServiceApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://Your.Server.URL/");
        
        // Configure API key authorization: paToken
        ApiKeyAuth paToken = (ApiKeyAuth) defaultClient.getAuthentication("paToken");
        paToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //paToken.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DataSourcesServiceApi apiInstance = new DataSourcesServiceApi();
        // Initialize the pyramidItemIdentifier parameter object for the call
        PyramidItemIdentifier pyramidItemIdentifier = ; // Create the input object for the operation, type: PyramidItemIdentifier 

        try {
            // "array[ConnectionStringProperties]" is only psaudo-code to symbolize list of type and not the actual usage 
            array[ConnectionStringProperties] result = apiInstance.getItemConnectionString(pyramidItemIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataSourcesServiceApi#getItemConnectionString");
            e.printStackTrace();
        }
    }
}

import * as PyramidAnalyticsWebApi from "com.pyramidanalytics";

// Create an instance of the API class
const api = new PyramidAnalyticsWebApi.DataSourcesServiceApi("http://Your.Server.URL")

// Configure API key authorization: paToken
api.setApiToken("YOUR API KEY");

const pyramidItemIdentifier = ; // {PyramidItemIdentifier} 

api.getItemConnectionString(pyramidItemIdentifier).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});


using System;
using System.Diagnostics;
using PyramidAnalytics.Sdk.Api;
using PyramidAnalytics.Sdk.Client;
using PyramidAnalytics.Sdk.Model;

public class getItemConnectionStringExample
{
    public static void Main()
    {
        Configuration conf = new Configuration();
        conf.BasePath = "http://Your.Server.URL/";
        
        
        // Configure API key authorization: paToken
        conf.ApiKey.Add("paToken", "YOUR_API_KEY");
        // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
        // conf.ApiKeyPrefix.Add("paToken", "Bearer");

        GlobalConfiguration.Instance = conf;
        
        // Create an instance of the API class
        var apiInstance = new DataSourcesServiceApi();
        // Initialize the pyramidItemIdentifier parameter object for the call
        var pyramidItemIdentifier = new PyramidItemIdentifier(); // PyramidItemIdentifier | 

        try {
            // Retrieves the connection details of the content item.
            // "array[ConnectionStringProperties]" is only psaudo-code to symbolize array of type and not the actual usage 
            array[ConnectionStringProperties] result = apiInstance.getItemConnectionString(pyramidItemIdentifier);
            Debug.WriteLine(result);
        } catch (Exception e) {
            Debug.Print("Exception when calling DataSourcesServiceApi.getItemConnectionString: " + e.Message );
        }
    }
}


import com.pyramidanalytics
from com.pyramidanalytics import ApiException
from com.pyramidanalytics import DataSourcesServiceApi
from pprint import pprint

        
# Configure API key authorization: paToken
api_config = com.pyramidanalytics.Configuration(host = 'http://Your.Server.URL/', api_key={ paToken:'YOUR_ACCESS_TOKEN' })

with com.pyramidanalytics.ApiClient(api_config) as api_client:
    # Create an instance of the API class
    api_instance = DataSourcesServiceApi(api_client)
    # Initialize the pyramidItemIdentifier parameter object for the call
    pyramidItemIdentifier =  # PyramidItemIdentifier | 

    try:
        # Retrieves the connection details of the content item.
        api_response = api_instance.get_item_connection_string(pyramidItemIdentifier)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DataSourcesServiceApi->getItemConnectionString: %s\n" % e)
<?php
require_once(__DIR__ . '/vendor/autoload.php');

OpenAPITools\Client\Configuration::getDefaultConfiguration()->setHost('http://Your.Server.URL');

// Configure API key authorization: paToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('paToken', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('paToken', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DataSourcesServiceApi();
$pyramidItemIdentifier = ; // PyramidItemIdentifier | 

try {
    $result = $api_instance->getItemConnectionString($pyramidItemIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataSourcesServiceApi->getItemConnectionString: ', $e->getMessage(), PHP_EOL;
}
?>